home *** CD-ROM | disk | FTP | other *** search
/ Aminet 5 / Aminet 5 - March 1995.iso / Aminet / util / time / MonkeyClock.lha / MonkeyClockV1.1 / MonkeyClock.doc < prev    next >
Text File  |  1994-12-06  |  9KB  |  293 lines
  1.  
  2.               +--------------------------------------+
  3.               |                             |
  4.               |    Welcome to MonkeyClock_v1.1 !     |
  5.               |    -----------------------------     |
  6.               |                            |
  7.               |                             |
  8.               |                   (Nov-21-1994) |
  9.               +--------------------------------------+
  10.  
  11.  
  12.  
  13.  
  14. [0] Index:
  15. ----------
  16.  
  17.   [0] This lines
  18.   [1] Introduction
  19.   [2] Installation
  20.   [3] Customization
  21.   [4] Copyrights and E-Mail-ware
  22.   [5] Disclaimer
  23.  
  24.  
  25.  
  26.  
  27. [1] Introduction
  28. ----------------
  29.  
  30.   MonkeyClock is a simple MUI + WB clock which has some powerful
  31.   customization options.
  32.   It is an E-Mail-ware program; read section [4] for further details. 
  33.   Please read carefully MUI.readme and MUIBuilder.readme files, too.
  34.  
  35.   To run MonkeyClock you need OS 2.0 (or higher) and muimaster.library
  36.   (you can find it in MUI user-package).
  37.  
  38.  
  39.  
  40.  
  41. [2] Installation
  42. ----------------
  43.  
  44.   You can simply double-click on Install-MonkeyClock icon (you don't
  45.   need installer, because it is only a shell script).
  46.   If you want to do it by hand follow these steps:
  47.  
  48.     - copy "monkey.config" file to S:
  49.     - copy "display.font" file and display directory (with its contents)
  50.       to FONTS: if you want to use this font with MonkeyClock.
  51.     - copy MonkeyClock and its icon to WBStartup: (or elsewhere)
  52.  
  53.   NOTE: if you use Install-MonkeyClock, MonkeyClock program will be
  54.     copied in SYS:WBStartup/ directory so it will be run every
  55.     time you turn on your Amiga.
  56.  
  57.  
  58.  
  59.  
  60. [3] Customization
  61. -----------------
  62.  
  63.   MonkeyClock has a configuration file ("monkey.config"), which should be
  64.   placed in directory "S:"; this file contains informations about fonts,
  65.   date and time formats, and alarm set-up.
  66.   
  67.  
  68.   FONTS
  69.   -----
  70.  
  71.   MonkeyClock uses two different fonts for displaying hour and date; they 
  72.   are specified in the two lines of configuration file:
  73.  
  74.     CLOCK_FONT: "<font name with full path>" , <font size>
  75.     DATE_FONT: "<font name with full path>" , <font size>
  76.  
  77.   For example, if you want the hour to be displayed using font Times and
  78.   size 11, you must add the following line in S:monkey.config
  79.  
  80.     CLOCK_FONT: "FONTS:Times.font" , 11
  81.  
  82.  
  83. * NOTE: if you want to CONTROL MonkeyClock FONTS WITH MUI, YOU MUST DELETE
  84.   THE TWO FONT LINES IN monkey.config: in this way, MonkeyClock uses MUI
  85.   font "Tiny" for date and MUI font "Fixed" for hour.
  86.  
  87.   The MonkeyClock archive contains a nice font, which looks great when used
  88.   to display hour in a high res laced screen; see installation section for
  89.   further details.
  90.  
  91.  
  92.   HOUR AND DATE FORMATS
  93.   ---------------------
  94.  
  95.   The best feature of MonkeyClock is that you can fully redefine what
  96.   it displays: you can set a clock that shows only the seconds, you can
  97.   add the name of your time-zone to the date, you can display the name
  98.   of your girl friend :?) between the day of the week and the year and so
  99.   on ...
  100.  
  101.   All these things can be easily achived selecting Format from MonkeyClock
  102.   menu: a new window will appear.
  103.   In this window you can change the hour and date format strings (labeled
  104.   'Time Fmt:' and 'Date Fmt:' ) which control what the clock displays.
  105.  
  106.   You can use some special sequences of characters (a '%' followed by
  107.   a letter) which have special meanings:
  108.  
  109.     SEQUENCE      MEANING
  110.  
  111.     %a          day of the week (abbreviation)
  112.     %A          day of the week ('Sunday', 'Monday', ...)
  113.     %b          month's name    (abbreviation)
  114.     %B          month's name      ('Genuary', 'February', ...)
  115.     %c          local date and hour
  116.     %d          day oh the month (01-31)
  117.     %H          hour (00-23)
  118.     %I          hour (01-12)
  119.     %j          day of the year
  120.     %m          month (01-12)
  121.     %M          minutes
  122.     %p          AM or PM (localized, i.e. local initials)
  123.     %S          seconds
  124.     %U          week of the year (00-53) (week begins on Sunday)
  125.     %w          day of the week (0-6)
  126.     %W          week of the year (00-53) (week begins on Monday)
  127.     %x          local date representation
  128.     %X          local hour representation
  129.     %y          year (00-99)
  130.     %Y          year with century
  131.     %Z          time zone name (if there is one)
  132.     %%          %
  133.  
  134.  
  135.   For example, if you want a clock which displays the message 'hello world'
  136.   between seconds and minutes, and only the year (with century) as date,
  137.   you must set the two strings as follow:
  138.  
  139.           +-------------------+
  140.     Time Fmt: |%S Hello World %M  |   
  141.           +-------------------+
  142.  
  143.           +-------------------+
  144.     Date Fmt: |%Y                 |
  145.           +-------------------+
  146.  
  147.  
  148.   In Format window you'll find some buttons, too:
  149.  
  150.  
  151.     Use        : apply changes to MonkeyClock
  152.     ---
  153.     Default        : set default time and date formats
  154.     -------
  155.     Cancel        : discard changes in format strings
  156.     ------
  157.     Load        : load time and date formats from monkey.config
  158.     ----
  159.     Save        : save time and date formats to monkey.config
  160.     ----
  161.  
  162.   (when MonkeyClock is started, it reads time and date formats from
  163.   monkey.config configuration file).
  164.  
  165.  
  166.   ALARM
  167.   -----
  168.  
  169.   MonkeyClock loses nothing in comparison with your favourite alarm-clock:
  170.   select Alarm from MonkeyClock menu and the Set-Alarm window will appear.
  171.   Use Hours and Minutes sliders to set the alarm-time, and click on
  172.   button [Alarm ON] to turn the alarm ON or OFF.
  173.   You can also change the alarm-message that will be displayed in
  174.   the alarm-window.
  175.  
  176.   In Set-Alarm window you'll find these buttons:
  177.  
  178.     Use        : use current alarm settings
  179.     ---
  180.     Save        : save current alarm settings to monkey.config
  181.     ----
  182.     Cancel        : discard current alarm settings
  183.     ------
  184.  
  185.   (when MonkeyClock is started, it reads alarm settings from monkey.config
  186.   configuration file).
  187.  
  188.  
  189.   When MonkeyClock notices that it's time to wake you up 8-|, it makes a
  190.   standard intuition screen-flash + beep and pop-ups a window with the
  191.   alert message; when you close this window, the alarm is automatically
  192.   turned off.
  193.  
  194.  
  195.   WINDOW POSITION AND MUI-SETTINGS
  196.   --------------------------------
  197.   If you don't have already registered your MUI package, your MUI
  198.   preferences program probably will not save your MUI settings (you
  199.   can save 'em only as global settings).
  200.  
  201.   So, if you have some trouble with MonkeyClock window position and
  202.   size try this:
  203.  
  204.     - drag and resize MonkeyClock until you find a good position in
  205.       your WB window, then double-click FixSize&Pos icon
  206.  
  207.     - when you turn on your Amiga, MonkeyClock will open
  208.       its window in your favourite position
  209.  
  210.  
  211.  
  212.  
  213. [4] Copyrights and E-Mail-ware
  214.  
  215.   MonkeyClock (v1.1) comes in the lharc archive MonkeyClock_v1.1.lha
  216.   which holds the following files:
  217.  
  218.     MonkeyClock        > the executable
  219.     MonkeyClock.info    > a nice icon for MonkeyClock
  220.     MonkeyClock.doc        > this text-file
  221.     MUI.readme        > something about MUI
  222.     MUIBuilder.readme    > something about MUIBuilder
  223.     Install_MonkeyClock    > the installation script
  224.     FixSize&Pos        > fix MonkeyClock position and size
  225.     monkey.config        > the configuration file
  226.     display.font        > a nice font for MonkeyClock
  227.     display/26        >
  228.  
  229.     plus some other .info files
  230.     
  231.   MonkeyClock is FREEWARE: the archive MonkeyClock_1.1.lha MAY BE FREELY
  232.   DISTRIBUTED, as long as no charges more than reasonable copying and
  233.   handling fees are collected!!!
  234.   You cannot modify (or leave out) none of its files and the display font
  235.   cannot be distributed outside the MonkeyClock package.
  236.   This program may be included in freeware collections, providing that the
  237.   previous conditions are respected.
  238.  
  239. >> TO SOFTWARE REVIEWS: if you include this program in one of your
  240.     disks, please send me a copy of the review, thanks :-)
  241.  
  242.  
  243. >> MonkeyClock is also E-Mail-ware: 
  244.    --------------------------------
  245.     if you decide to install it, please send me an email to give me some
  246.     ideas or remarks ... if you find some BUGS, send me an email ...
  247.     if you hate it, send me an email, too ... (-B
  248.  
  249.  
  250.  
  251.   My address:
  252.  
  253.  
  254.             +--------------------------------------+
  255.             |                                      |
  256.             |     De Biasi Marzio                  |
  257.             |     via Borgo Simoi, 34              |
  258.             |     31029 Vittorio Veneto (TV)       |
  259.             |     Italy                            |
  260.             |                                      |
  261.             |     E-Mail: debiasi@dimi.uniud.it    |
  262.             |                                      |
  263.             +--------------------------------------+
  264.   
  265.  
  266.  
  267.   Thanks!!!
  268.  
  269.  
  270.  
  271.  
  272. [5] Disclaimer
  273. --------------
  274.    THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
  275. APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
  276. HOLDER AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
  277. OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
  278. THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  279. PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
  280. PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE
  281. COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
  282.  
  283.    IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
  284. WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY REDISTRIBUTE THE
  285. PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
  286. GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
  287. USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS
  288. OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR
  289. THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
  290. PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
  291. POSSIBILITY OF SUCH DAMAGES.
  292.  
  293.